'\" te
.\" Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH PTREE_GET_NODE_BY_PATH 3PICLTREE "April 9, 2016"
.SH NAME
ptree_get_node_by_path \- get handle of node specified by PICL tree path
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpicltree\fR [ \fIlibrary\fR... ]
#include <picltree.h>

\fBint\fR \fBptree_get_node_by_path\fR(\fBconst char *\fR\fIptreepath\fR,
     \fBpicl_nodehdl_t *\fR\fInodeh\fR);
.fi

.SH DESCRIPTION
.LP
The \fBptree_get_node_by_path()\fR function copies the handle of the node in
the PICL tree specified by the path given in \fIptreepath\fR into the location
\fInodeh\fR.
.sp
.LP
The syntax of a PICL tree path is:
.sp
.in +2
.nf
[\fIdef_propname\fR:]/[\fIdef_propval\fR[\fImatch_cond\fR] \&.\|.\|. ]
.fi
.in -2

.sp
.LP
where \fIdef_propname\fR prefix is a shorthand notation to specify the name of
the property whose value is specified in \fIdef_propval\fR, and the
\fImatch_cond\fR expression specifies the matching criteria for that node in
the form of one or more pairs of property names and values such as
.sp
.in +2
.nf
[@\fIaddress\fR][?\fIprop_name\fR[=\fIprop_val\fR] \&.\|.\|. ]
.fi
.in -2

.sp
.LP
where '@' is a shorthand notation to refer to the device address, which is
followed by the device address value address. The address value is matched with
the value of the property "bus-addr" if it exists. If no "bus-addr" property
exists, then it is matched with the value of the property "UnitAddress". Use
the '?' notation to limit explicitly the comparison to "bus-addr" or
"UnitAddress" property.  The expression following '?' specifies matching
property name and value pairs, where \fIprop_name\fR gives the property name
and \fIprop_val\fR gives the property value for non \fBPICL_PTYPE_VOID
\fRproperties. The values for properties of type \fBPICL_PTYPE_TABLE\fR,
\fBPICL_PTYPE_BYTEARRAY\fR, and \fBPICL_PTYPE_REFERENCE\fR cannot be specified
in the \fImatch_cond\fR expression.
.sp
.LP
A "_class" property value of "picl" may be used to match nodes of all PICL
classes.
.sp
.LP
All valid paths must start at the root node denoted by '/'.
.sp
.LP
If no prefix is specified for the path, then the prefix defaults to the "name"
property.
.SH RETURN VALUES
.LP
Upon successful completion, \fB0\fR is returned. On failure, a non-negative
integer is returned to indicate an error.
.sp
.LP
\fBPICL_NOTNODE\fR is returned if there is no node corresponding to the
specified path.
.SH ERRORS
.ne 2
.na
\fB\fBPICL_INVALIDARG\fR\fR
.ad
.RS 19n
Invalid argument
.RE

.sp
.ne 2
.na
\fB\fBPICL_NOTNODE\fR\fR
.ad
.RS 19n
Not a node
.RE

.sp
.ne 2
.na
\fB\fBPICL_FAILURE\fR\fR
.ad
.RS 19n
General system failure
.RE

.SH ATTRIBUTES
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Evolving
_
MT-Level	MT-Safe
.TE

.SH SEE ALSO
.LP
.BR ptree_get_propval_by_name (3PICLTREE),
.BR attributes (7)
